RDKEMW-12176: btrCore_PopulateListOfPairedCrash_p - #75
Open
PreethiALPI wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses a crash during teardown (e.g., deep sleep) by adding teardown-awareness to btrCore and updating unit tests to validate termination behavior.
Changes:
- Add a global “terminating” flag and per-handle generation tracking to reduce UAF risk during teardown.
- Harden service-data copying by clamping advertised service-data length to the destination buffer size.
- Update/extend unit tests to initialize generation and assert termination behavior across DeInit scenarios.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/btrCore.c |
Adds termination/generation tracking and a termination guard in paired-device population; clamps service-data copy length. |
include/btrCore.h |
Exposes UNIT_TEST-only helpers for generation/termination inspection. |
unitTest/test_btrCore.c |
Updates tests to set generation, resets terminator where needed, and adds DeInit termination tests. |
Comments suppressed due to low confidence (1)
src/btrCore.c:1226
- The trace loop iterates using the source service-data length, but reads from the destination buffer (
pcData) which is clamped toBTRCORE_MAX_SERVICE_DATA_LEN. IfsaServices[count].lenexceeds the max, this will read past the end ofpcData(OOB read) during logging.
for (int i =0; i < apstBTDeviceInfo->saServices[count].len; i++){
BTRCORELOG_TRACE ("ServiceData[%d] = [%x]\n ", i, lstFoundDevice.stAdServiceData[count].pcData[i]);
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+298
to
+301
| void btrCore_ResetTerminatorForTest(void) { | ||
| g_atomic_int_set(&gIsBtrCoreTerminating, 0); | ||
| gint val = g_atomic_int_get(&gIsBtrCoreTerminating); | ||
| } |
Comment on lines
+303
to
+306
| void btrCore_SetTerminatorForTest(void) { | ||
| g_atomic_int_set(&gIsBtrCoreTerminating, 1); | ||
| gint val = g_atomic_int_get(&gIsBtrCoreTerminating); | ||
| } |
| @@ -4171,6 +4350,7 @@ void test_BTRCore_SetAdvertisementInfo_NullAdvtType(void) { | |||
| tBTRCoreHandle hBTRCore = (tBTRCoreHandle)1; // Mock handle | |||
| char advtBeaconName[] = "BeaconName"; | |||
|
|
|||
| /* Invalid handle value - should never be deferenced */ | |||
Reason for change: Crash fix Test Procedure: Device deepsleep causing the crash Risks: Low Priority: P2 Signed-off-by: ppalan289 <preethi_palanisamy@comcast.com>
PreethiALPI
force-pushed
the
RDKEMW-12176_a1
branch
from
July 8, 2026 10:37
beef42a to
3b92c89
Compare
Comment on lines
+1518
to
+1522
| /* Prevent UAF when worker threads run during teardown */ | ||
| if(g_atomic_int_get(&gIsBtrCoreTerminating)) { | ||
| BTRCORELOG_WARN("btrCore: Ignoring PopulateListOfPairedDevices during termination\n"); | ||
| return enBTRCoreFailure; | ||
| } |
Comment on lines
+298
to
+301
| void btrCore_ResetTerminatorForTest(void) { | ||
| g_atomic_int_set(&gIsBtrCoreTerminating, 0); | ||
| gint val = g_atomic_int_get(&gIsBtrCoreTerminating); | ||
| } |
Comment on lines
+303
to
+306
| void btrCore_SetTerminatorForTest(void) { | ||
| g_atomic_int_set(&gIsBtrCoreTerminating, 1); | ||
| gint val = g_atomic_int_get(&gIsBtrCoreTerminating); | ||
| } |
Reason for change: Crash fix Test Procedure: Device deepsleep causing the crash Risks: Low Priority: P2 Signed-off-by: ppalan289 <preethi_palanisamy@comcast.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated no new comments.
Suppressed comments (1)
src/btrCore.c:1224
- The trace loop indexes
pcDataup to the original service-data length (apstBTDeviceInfo->saServices[count].len), butpcDatais only filled up to the clamped length (stAdServiceData[count].len). If the incoming length exceedsBTRCORE_MAX_SERVICE_DATA_LEN, this loop will read pastpcDataand can crash/log garbage.
lstFoundDevice.stAdServiceData[count].len = (apstBTDeviceInfo->saServices[count].len < BTRCORE_MAX_SERVICE_DATA_LEN) ? apstBTDeviceInfo->saServices[count].len : BTRCORE_MAX_SERVICE_DATA_LEN;
MEMCPY_S(lstFoundDevice.stAdServiceData[count].pcData, BTRCORE_MAX_SERVICE_DATA_LEN, apstBTDeviceInfo->saServices[count].pcData, lstFoundDevice.stAdServiceData[count].len);
BTRCORELOG_TRACE ("ServiceData from %s\n", __FUNCTION__);
for (int i =0; i < apstBTDeviceInfo->saServices[count].len; i++){
BTRCORELOG_TRACE ("ServiceData[%d] = [%x]\n ", i, lstFoundDevice.stAdServiceData[count].pcData[i]);
}
Reason for change: Crash fix Test Procedure: Device deepsleep causing the crash Risks: Low Priority: P2 Signed-off-by: ppalan289 <preethi_palanisamy@comcast.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated no new comments.
Suppressed comments (2)
src/btrCore.c:82
- gBtrCoreGenerationCounter is used with GLib atomic APIs (g_atomic_int_add/get), which expect a volatile gint storage. Declaring it as non-volatile can cause compiler warnings or undefined behavior depending on platform/GLib implementation.
/* Prevent UAF during teardown */
static volatile gint gIsBtrCoreTerminating = 0;
/* Track active instance generation - helps to check if current handle is same as that of terminated handle. */
static gint gBtrCoreGenerationCounter = 0;
src/btrCore.c:1524
- The termination guard log message is misleading: the condition also triggers for a stale (non-current) handle, not just during termination. Splitting the checks makes logs actionable and also fixes the typo "gmalloc0" -> "g_malloc0".
/* Prevent UAF when worker threads run during teardown */
if((apsthBTRCore->generation != g_atomic_int_get(&gBtrCoreGenerationCounter)) || g_atomic_int_get(&gIsBtrCoreTerminating)) {
BTRCORELOG_WARN("btrCore: Ignoring PopulateListOfPairedDevices during termination\n");
return enBTRCoreFailure;
}
if ((pstBTPairedDeviceInfo = g_malloc0(sizeof(stBTPairedDeviceInfo))) == NULL) {
BTRCORELOG_WARN("btrCore: gmalloc0 failed\n");
return enBTRCoreFailure;
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reason for change: Crash fix
Test Procedure: Device deepsleep causing the crash
Risks: Low
Priority: P2